home *** CD-ROM | disk | FTP | other *** search
/ Pluspack 1 / Caligari Corporation Pluspack1 1998.iso / TSX_SDK / tsxINC / tsxErr.h < prev    next >
Encoding:
C/C++ Source or Header  |  1998-01-28  |  2.0 KB  |  59 lines
  1. //******************************************************************************
  2. //    File: tsxErr.h
  3. //  Module: trueSpace eXtensions API
  4. //   Descr: TSX Error Codes
  5. //******************************************************************************
  6.  
  7. #ifndef TSXERR_H
  8. #define TSXERR_H
  9.  
  10. #include "tsxTypes.h"
  11.  
  12.  
  13. //------------------------------------------------------------------------------
  14. //    Error Codes returned by Functions with return type tsxERR
  15. //------------------------------------------------------------------------------
  16.  
  17. #define tsxERR_SUCCESS 0
  18.  
  19. // Defined Error Codes
  20.  
  21. #define tsxERR_NOGOOD       -1 // something generally went wrong
  22. #define tsxERR_NO_MEMORY   -2 // no memory available
  23. #define tsxERR_NULL_REF       -3 // null pointer reference
  24. #define tsxERR_BAD_INPUT   -4 // bad input data
  25. #define tsxERR_FORMAT       -5 // general bad data format
  26. #define tsxERR_ABORT       -8 // user abort request
  27. #define tsxERR_REPORTED      -10 // still an error but was reported below
  28. #define tsxERR_UNIMPL      -11 // feature unimplemented
  29. #define tsxERR_IDENTIFIER -12 // bad identifier on data or record
  30. #define tsxERR_VERSION       -13 // Correct file type but wrong version
  31. #define tsxERR_NOT_FOUND  -14 // object not found
  32. #define tsxERR_OVERFLOW      -15 // data overflow for size of result
  33. #define tsxERR_RANGE      -16 // value out of range
  34. #define tsxERR_INIT      -18 // subsystem improperly initialized
  35.  
  36. // system errors
  37. #define tsxERR_SYSERR_BASE -50
  38. #define tsxERR_STDIO      (tsxERR_SYSERR_BASE -0) // error occurred in io
  39. #define tsxERR_MSWIN      (tsxERR_SYSERR_BASE -1) // error occurred in windows
  40.  
  41. // If a function returns an error code not defined above, then treat it
  42. // as an undefined error.
  43.  
  44.  
  45. // A function may (rare) return positive success codes ...
  46. inline tsxBOOL tsxSUCCEEDED( tsxERR err )
  47. {
  48.     return (tsxBOOL) (err >= 0);
  49. }
  50.  
  51. inline tsxBOOL tsxFAILED( tsxERR err )
  52. {
  53.     return (tsxBOOL) (err < 0);
  54. }
  55.  
  56.  
  57. //*****************************************************************************
  58. #endif // TSXERR_H
  59.